﻿//-----------------------------------------------------------------------
// <copyright file="ActionModule.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace App.Modules.Action
{
    using App.Modules.Component;
    using App.Modules.Message;
    using TileTool.Action;
    using TileTool.Action.Message;
    using TileTool.Editor.Command;
    using TileTool.Log;
    using TileTool.Message;

    /// <summary>
    /// Application action module.
    /// </summary>
    public class ActionModule : Module
    {
        #region Constants - Private

        /// <summary>
        /// Log message group.
        /// </summary>
        private const string LogGroup = "ActionModule";

        #endregion

        #region Fields - Private

        /// <summary>
        /// Action manager to use for the application.
        /// </summary>
        private IActionManager actionManager = null;

        #endregion

        #region Methods - Public

        /// <summary>
        /// Called when the application is starting up.
        /// </summary>
        public override void Startup()
        {
            LogSystem.LogStartup(LogGroup, "Starting...");

            ComponentModule componentModule = GetModule<ComponentModule>();
            MessageModule messageModule = GetModule<MessageModule>();
            ActionManagerFactoryComponentBase factory = componentModule.Get<ActionManagerFactoryComponentBase>(ComponentAliases.ActionManager);

            LogSystem.LogStartup(LogGroup, "Allocating action manager...");
            this.actionManager = factory.Allocate(messageModule.MessageRouter);

            base.Startup();
        }

        /// <summary>
        /// Called when the application is shutting down.
        /// </summary>
        public override void Shutdown()
        {
            base.Shutdown();

            this.actionManager = null;
        }

        /// <summary>
        /// Register for messages.
        /// </summary>
        public override void RegisterForMessages()
        {
            base.RegisterForMessages();

            MessageModule messageModule = GetModule<MessageModule>();
            MessageRouter router = messageModule.MessageRouter;

            router.RegisterForMessage<ActionMessage>(
                this.HandleActionMessage,
                MessageHandlerPriority.Max);

            router.RegisterForMessage<CommandIdMessage>(
                this.HandleUndoCommandMessage,
                MessageHandlerPriority.Default,
                new CommandIdMessageFilter(EditorCommandIds.UndoCommand));

            router.RegisterForMessage<CommandIdMessage>(
                this.HandleRedoCommandMessage,
                MessageHandlerPriority.Default,
                new CommandIdMessageFilter(EditorCommandIds.RedoCommand));
        }

        /// <summary>
        /// Unregister for messages.
        /// </summary>
        public override void UnregisterForMessages()
        {
            base.UnregisterForMessages();

            MessageModule messageModule = GetModule<MessageModule>();
            MessageRouter router = messageModule.MessageRouter;

            router.UnregisterForMessage<ActionMessage>(this.HandleActionMessage);
            router.UnregisterForMessage<CommandIdMessage>(this.HandleUndoCommandMessage);
            router.UnregisterForMessage<CommandIdMessage>(this.HandleRedoCommandMessage);
        }

        #endregion

        #region Methods - Private

        /// <summary>
        /// Handle an action message.
        /// </summary>
        /// <param name="message">Action message to handle.</param>
        /// <returns>Returns if the message was handled or not.</returns>
        private MessageHandlerResult HandleActionMessage(ActionMessage message)
        {
            this.actionManager.Add(message.Action);

            return MessageHandlerResult.Ignored;
        }

        /// <summary>
        /// Handle a undo command ID message.
        /// </summary>
        /// <param name="message">Command ID message to handle.</param>
        /// <returns>Returns if the message was handled or not.</returns>
        private MessageHandlerResult HandleUndoCommandMessage(CommandIdMessage message)
        {
            this.actionManager.Undo();

            return MessageHandlerResult.Ignored;
        }

        /// <summary>
        /// Handle a redo command ID message.
        /// </summary>
        /// <param name="message">Command ID message to handle.</param>
        /// <returns>Returns if the message was handled or not.</returns>
        private MessageHandlerResult HandleRedoCommandMessage(CommandIdMessage message)
        {
            this.actionManager.Redo();

            return MessageHandlerResult.Ignored;
        }

        #endregion
    }
}
